6.1.0 Values.yaml

You can use values.yaml or provide an over-rides file for bringing up a running Local Edition cluster using Helm. Edit values to provide different configurations that are required to deploy pods and services on Kubernetes. The entries affect all K8s resources such as pods, containers, services, cron jobs, configmaps, and secrets.

note

When editing values.yaml or providing an over-rides file, ensure that no yaml rules are broken. An improper edit can result in preventing the application from being deployed successfully.

You can verify compliance for the YAML syntax by using the following command:

helm lint

You must review and modify the following properties:

Values.global.acceptEUA

• You must set the value to true before deploying the chart.

• Impacted templates:

  • cacheloader-deploy.yaml

  • configui-deploy.yaml

  • platformapi-deploy.yaml

  • trafficmanager-deploy.yaml

• Data type: boolean

• Default value: false

• Acceptable values: true and false.

Values.global.apimClusterMode

• Property to govern how the cluster will be deployed.

• Possible values: tethered and untethered. The values are case sensitive.

  In tethered mode, the cluster depends on the Boomi Cloud API Management for configuration and policies.

  Refer to Mashery Onprem Manager (MOM) API key and Secret section in Other Secrets for more information.

• Impacted templates: configui-configmap.yaml, loader-configmap.yaml, and loader-job.yaml

• Data type: string

• Default value: untethered

Values.global.apimImageRegistry

• The FQDN or IP address of the image registry from which the application images are pulled. You must provide this value.

• Impacted templates:

  • cache-deploy.yaml

  • cacheloader-cronjob.yaml

  • cacheloader-deploy.yaml

  • configui-deploy.yaml

  • platformapi-deploy.yaml

  • startup-cacheloader-job.yaml

  • trafficmanager-deploy.yaml

• Data type: string

• Default value: -

• Acceptable values: Resolvable and reachable FQDN or IP address and optionally provide registry.

  For example - mycompany.harbor.com, mycompany.harbor.com/apimtrials

Values.global.imagePullSecrets

• Image pull secrets are created as a part of preinstall checklist. This is required only for secure image registry. If you are not using secure registries, leave the default value.

• Impacted templates:

  • cache-deploy.yaml

  • cacheloader-cronjob.yaml

  • cacheloader-deploy.yaml

  • configui-deploy.yaml

  • platformapi-deploy.yaml

  • startup-cacheloader-job.yaml

  • trafficmanager-deploy.yaml

• Data type: array

• Default value: []

• Acceptable values: An array of secret names declared in Kubernetes syntax.

  For example,imagePullSecrets:

  • name:secret1

  • name:secret2

Values.global.namespace

important

The Values.global.namespace is only applicable to LE v6.0.0 and v6.1.0, but has been deprecated and removed as of LE v6.2.0. Refer to 6.2.0 Values.yaml for more information.

• Kubernetes namespace in which Local Edition resources are created.

  caution

  AKS places restrictions on using the default namespace.

• Impacted templates:

  • cache-deploy.yaml

  • cacheloader-cronjob.yaml

  • cacheloader-deploy.yaml

  • configui-deploy.yaml

  • platformapi-deploy.yaml

  • startup-cacheloader-job.yaml

  • trafficmanager-deploy.yaml

• Data type: string

• Default value: default

• Acceptable values: Any K8s legal string value.

Values.global.apimClusterName

• Cluster name is a unique identifier to a Local Edition instance. This value is important in instances where multiple Local Edition clusters share the same database.

• Impacted templates:

  • cacheloader-deploy.yaml

  • cache-deploy.yaml

  • trafficmanager-deploy.yaml

  • Data type: string

• Default value: apiml1

• Acceptable values: It must be unique for each cluster sharing the same database.

Values.global.imagePullPolicy

• The image pull policy governs when the kubelet should pull images.

• Impacted templates:

  • cacheloader-deploy.yaml

  • startup-cacheloader-job.yaml

  • cacheloader-cronjob.yaml

  • cache-deploy.yaml

  • platformapi-deploy.yaml

  • configui-deploy.yaml

  • fluentbit-daemonset.yaml

  • trafficmanager-deploy.yaml

• Data type: string

• Default value: Always

• Acceptable values: IfNotPresent, Always, Never

Values.global.securityContext.runAsUser

• Local Edition images has the default user: nonroot - 65532.

  You can change the value based on your organization policies. This is a good security practice.

  caution

  • Refrain from using user 0.

  • OpenShift users must provide a value based on their OpenShift policies. In general, OpenShift expects larger values enforced by dynamic range - generally between 1000000000 and 2000000000. You can refer sa.scc.uid-range for Openshift project.

• Impacted templates:

  • cacheloader-deploy.yaml

  • startup-cacheloader-job.yaml

  • cacheloader-cronjob.yaml

  • cache-deploy.yaml

  • platformapi-deploy.yaml

  • configui-deploy.yaml

  • fluentbit-daemonset.yaml

  • trafficmanager-deploy.yaml

• Data type: integer

• Default value: 10001

• Acceptable values: Any integer only within range 1 to 65535. Check the clusters' SCC setting for range.

Values.global.securityContext.runAsGroup

• Local Edition images has the default group: nonroot - 65532.

  You can change the value based on your organization policies. This is a good security practice.

  caution

  • Refrain from using group 0.

  • OpenShift users must provide a value based on their OpenShift policies. In general, OpenShift expects larger values enforced by dynamic range - generally between 1000000000 and 2000000000. You can refer sa.scc.supplemental-groups for Openshift project

• Impacted templates:

  • cacheloader-deploy.yaml

  • startup-cacheloader-job.yaml

  • cacheloader-cronjob.yaml

  • cache-deploy.yaml

  • platformapi-deploy.yaml

  • configui-deploy.yaml

  • fluentbit-daemonset.yaml

  • trafficmanager-deploy.yaml

• Data type: integer

• Default value: 10001

• Acceptable values: Any integer only within range 1 to 65535. Check the clusters' SCC setting for range.

Values.global.securityContext.openshiftDeployment

• In case of OpenShift deployment, this value must be set to true.

• Impacted templates:

  • cacheloader-deploy.yaml

  • startup-cacheloader-job.yaml

  • cacheloader-cronjob.yaml

  • cache-deploy.yaml

  • platformapi-deploy.yaml

  • configui-deploy.yaml

  • fluentbit-daemonset.yaml

  • trafficmanager-deploy.yaml

• Data type: boolean

• Default value: false

• Accepted values: true and false

Values.global.mysqlDatabase.host

• This is a host name, IP address, or managed service database instance's FQDN.

• Impacted templates:

  • platformapi-configjson-configmap.yaml

  • cacheloader-configmap.yaml

  • trafficmanager-configmap.yaml

  • configui-configmap.yaml

• Data type: string

Values.global.mysqlDatabase.port

• The port number on which the database is listening for client connections.

• Impacted templates:

  • platformapi-configjson-configmap.yaml

  • cacheloader-configmap.yaml

  • trafficmanager-configmap.yaml

  • configui-configmap.yaml

• Data type: integer

• Default value: 3306

• Acceptable value: Port number

Values.global.mysqlDatabase.sslMode

• This setting informs whether you want to communicate with the database via TLS. Refer to Securing Connections to an External MySQL 8 compliant database for more information.

• Impacted templates:

  • cacheloader-deploy.yaml

  • cache-deploy.yaml

  • platformapi-deploy.yaml

  • trafficmanager-deploy.yaml

  • configui-deploy.yaml

• Data type: string

• Default value: disable

• Acceptable values: disable, trust, verify-ca, verify-full

Values.global.mysqlDatabase.mutualTls

• This setting informs clients if they have to use mTLS to the database. Refer to Securing Connections to an External MySQL 8 compliant database for more information.

• Impacted templates:

  • cacheloader-deploy.yaml

  • cache-deploy.yaml

  • platformapi-deploy.yaml

  • trafficmanager-deploy.yaml

  • configui-deploy.yaml

• Data type: string

• Default value: disable

• Acceptable values: enable and disable

Values.global.mysqlDatabase.connectTimeout

• Time in seconds the database server waits for a client connection to send more data before aborting the read operation.

• Impacted templates:

  • cacheloader-deploy.yaml

  • cache-deploy.yaml

  • platformapi-deploy.yaml

  • trafficmanager-deploy.yaml

  • configui-deploy.yaml

• Data type: integer or long

• Default value: 4000

Values.global.mysqlDatabase.netReadTimeout

• Time in seconds to wait on writing a block to a connection before aborting the write. It also defines how long the database server waits for the client to retrieve the entire result set.

• Impacted templates:

  • cacheloader-deploy.yaml

  • cache-deploy.yaml

  • platformapi-deploy.yaml

  • trafficmanager-deploy.yaml

  • configui-deploy.yaml

• Data type: integer or long

• Default value: 30

Values.global.mysqlDatabase.netWriteTimeout

• Defines the network socket timeout (SO_TIMEOUT) in milliseconds. Value of 0 (default) disables this timeout.

• Impacted templates:

  • cacheloader-deploy.yaml

  • cache-deploy.yaml

  • platformapi-deploy.yaml

  • trafficmanager-deploy.yaml

  • configui-deploy.yaml

• Data type: integer or long

• Default value: 360

Values.global.email.mail.transport.protocol

• Protocol represents the system to notify users. See the comments in the values.yaml for additional settings for each protocol.

• Impacted templates:

  • trafficmanager-deploy.yaml

  • configui-deploy.yaml

• Data type: string

• Default value: log

• Acceptable values: aws, smtp, and log.

Values.global.localDevAdminUser

• Property is used by ConfigUI to bootstrap the authentication flow. We recommend changing this value.

• Impacted templates:

  • configui-configmap.yaml
  • loader-deploy.yaml

• Data type: string

• Default value: admin

Values.global.localDevOAuthScope

• Property is used by ConfigUI to restrict data access to a particular area.

• The value for this property is dependent on apimClusterMode. If apimClusterMode is untethered, you must generate the value using the customize script. If tethered, you can use the value you get after signing to Boomi Cloud API Management Cloud Control Center.

• Impacted templates:

  • configui-configmap.yaml
  • preinstall-job.yaml

• Data type: string UUID

• Default value: none

  Refer to Customising IDs and Keys for Local Edition for more information.

Values.global.k8sServiceType

• Property that allows Kubernetes services of a particular type.

• Impacted templates:

  • trafficmanager-svc.yaml

  • platformapi-svc.yaml

  • configui-svc.yaml

  • cacheloader-svc.yaml

  • cache-svc.yaml

• Data type: string

• Default value: LoadBalancer

• Acceptable values: LoadBalancer, NodePort, ClusterIP.

Values.global.domainSuffix

• This is the domain that is provided when you customized seed data. The default value is mashery.com

• Impacted templates:

  • platformapi-deploy.yaml

  • configui-deploy.yaml

  • `configui-configimap.yaml``

• Data type: string

• Default value: mashery.com

• Acceptable values: The text should be in the form of domain_name.tld or domain_name. For example, mycompany.com or myorganization.org or mycompany or myorganization.

Optional Properties

note

The following properties are optional.

Values.global.logging.includeFluentBitContainer

The fluent-bit side car on K8s requires specific capabilities. If your security settings do not allow it, disable fluent-bit.

caution

OpenShift imposes further restrictions that do not allow fluent-bit to access console logs of the pods. For OpenShift, you can either disable fluent-bit or allow fluent-bit to access log file on the pod. Refer to Values.global.logging.appLogLocation for more information.

• Property is used to control the deployment of fluent-bit side car. When set to false, it excludes fluent-bit container side-car.

• Possible values: true | false When set to false, it will output logs to the primary container console. In such case, you must configure logging agents to send logs to the observability stack.

• Data type: boolean

• Default value: true

Values.global.logging.appLogLocation

• Property is used to configure the Application log destination.

• Data type: string

• Default value: console

• Possible values: console | filesystem. The value is case sensitive.

  When set to console it emits the logs to the fluent-bit container console. Kubelet manages the logs. If it is set to fliesystem, logs are written to a temp file inside the pod. Fluent-bit tails this file to stream the logs.

  warning

  In filesystem mode, logs are not retained when pod restarts. You may also notice performance degradation and higher resource utilization.

  info

  In either mode, logs are still available on the primary container console.

Values.global.logging.filesystem.rollovertrigger.maxFileSize

• Property to configure file rollover file size trigger.

• Value is in Megabytes(MB)

• Applicable only if appLogLocation is set to filesystem.

• Data type: integer

• Default value: 20

• Possible value: Any integer greater than zero. The value is read set as MB.

  warning

  Do not set it to a very high value, as this will result in higher disk utilization.

Values.global.logging.filesystem.rollovertrigger.totalFileSizeCap

• Property to define the total archive file cap size.

• Possible value: Any integer greater than 0.

• Value is in Gigabytes(GB).

• Applicable only if appLogLocation is set to filesystem.

• Data type: integer

• Default value: 1

warning

Do not set it to a high value, as this will result in higher disk utilization.

Values.global.logging.filesystem.retentionPolicy.maxFiles

• Property to define how many archive files can be to retained. The rolled over files are gzipped. Older files are deleted when the maximum number of files are reached.

• Possible value: Any integer greater than 0.

• Applicable only if appLogLocation is filesystem.

• Data type: integer

• Default value: 10

warning

Do not set it to a high value, as this will result in higher disk utilization.

Values.global.logging.filesystem.retentionPolicy.maxAge

• Property to define how long archive files have to be retained. The rolled over files are gzipped. Older files are deleted when the maximum number of days are reached.

• Possible value: Any integer greater than 0

• Applicable only if appLogLocation is filesystem

• Data type: integer

• Default value: 28

warning

Do not set it to a high value, as this will result in higher disk utilization.

Values.global.logging.filesystem.logDirectory

• Property to configures the file destinations(directory) for log files.

• Possible value: Any string denoting a directory path (full path) The value is full path or relative path. Relative path result in errors.

• Data type: string (Directory path).

  caution

  Do not add / at the end.

• Default value: /tmp/logs

  warning

  Use only /tmp as root directory.

Values.preInstallDBPrep.populateSeedData

• Property determines whether the database should be populated with seed data. It is needed only for the first time. Set the value to yes, if you are installing this for the first time.

• Possible values: true|false|yes\no|True|False|Yes|No|TRUE|FALSE|YES|NO

• Impacted Templates: preinstall-job.yaml

• Data type: string

• Default value: No

Values.preInstallDBPrep.apiKey

• Property defines API key for ConfgUI to call Platform API REST resources.

• Impacted templates: preinstall-job.yaml

Values.preInstallDBPrep.localDevAdminPassword

• Property that allows to change the password.

  note

  It is mandatory for users to change their password. For security reasons, we recommend providing this value in the command line (helm install) while installing the application. Refer to 6.1.0: Installing Local Edition section for more information.

Values.trafficmanager.replicas

• Property that allows Helm (and Kubernetes) to scale the trafficmanager. Set the value and run helm upgrade.

• Impacted template: trafficmanager-deploy.yaml

• Data type: integer

• Default value: 1

• Acceptable values: Any number. However, the number of pods that can actually be scaled out depends on available resources.

Values.platformapi.replicas

• Property that allows Helm (and Kubernetes) to scale platformapi. Set the value and run helm upgrade.

• Impacted template: platformapi-deploy.yaml

• Data type: integer

• Default value: 1

• Acceptable values: Any number. However, the number of pods that can actually be scaled out depends on available resources.

Values.configui.replicas

• Property that allows Helm (and Kubernetes) to scale the configui. Set the value and run helm upgrade.

• Impacted template: configui-deploy.yaml

• Data type: integer

• Default value: 1

• Acceptable values: Any number. However, the number of pods that can actually be scaled out depends on available resources.

Values.cacheloader.replicas

• Property that allows Helm (and Kubernetes) to scale the cacheloader. Set the value and run helm upgrade.

• Impacted template: cacheloader-deploy.yaml

• Data type: integer

• Default value: 1

• Acceptable values: Any number. However, the number of pods that can actually be scaled out depends on available resources.

Values.cache.replicas

• Property that allows Helm (and Kubernetes) to scale the cache. Set the value and run helm upgrade.

• Impacted template: cache-deploy.yaml

• Data type: integer

• Default value: 3

• Acceptable values: Any number. However, the number of pods that can actually be scaled out depends on available resources.

Values.trafficmanager.tag

• Update this value based on the tag set during image push. You must change this value based on the tag used when you pushed images to a registry.

• Impacted template: trafficmanager-deploy.yaml

• Data type: string

• Default value: v6.0.0

• Acceptable values: Alpha-numeric without spaces and no special characters.

Values.platformapi.tag

• Update this value based on the tag set during image push. You must change this value based on the tag used when you pushed images to a registry.

• Impacted template: platformapi-deploy.yaml

• Data type: string

• Default value: v6.0.0

• Acceptable values: Alpha-numeric without spaces and no special characters.

Values.loader.tag

• Update this value based on the tag set during image push. You must change this value based on the tag used when you pushed images to a registry.

• Impacted template: cacheloader-deploy.yaml

• Data type: string

• Default value: v6.0.0

• Acceptable values: Alpha-numeric without spaces and no special characters.

Values.loadercron.tag

• Update this value based on the tag set during image push. You must change this value based on the tag used when you pushed images to a registry.

• Impacted template:

  • startup-cacheloader-job.yaml

  • cacheloader-cronjob.yaml

• Data type: string

• Default value: v6.0.0

• Acceptable values: Alpha-numeric without spaces and no special characters.

Values.cache.tag

• Update this value based on the tag set during image push. You must change this value based on the tag used when you pushed images to a registry.

• Impacted template: cache-deploy.yaml

• Data type: string

• Default value: v6.0.0

• Acceptable values: Alpha-numeric without spaces and no special characters.

Values.fluentbit.tag

• Local Edition uses Fluent Bit 2.2.1

• Impacted template:

  • fluentbit-daemonset.yaml

  • trafficmanager-deploy.yaml

• Data type: string

• Default value: 2.2.1

• Acceptable values: Alpha-numeric without spaces and no special characters.

  caution

  Do not make any changes without consulting the Boomi Account Representative.

Values.fluentbit.image

• Local Edition uses Fluent Bit official image fluent/fluent-bit from DockerHub.

• Impacted templates:

  • fluentbit-daemonset.yaml

  • trafficmanager-deploy.yaml

• Data type: string

• Default value: fluent/fluent-bit

• Acceptable values: Alpha-numeric without spaces and no special characters.

  caution

  Do not make any changes without consulting the Boomi Account Representative.